Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor!: Move Grid out of detail #2616

Merged
merged 4 commits into from
Nov 3, 2023

Conversation

paulgessinger
Copy link
Member

This is part of the public API (and documented to some degree) so shouldn't be in detail.

This is part of the public API (and documented to some degree) so
shouldn't be in `detail`.
@paulgessinger paulgessinger added this to the v31.0.0 milestone Nov 2, 2023
AJPfleger
AJPfleger previously approved these changes Nov 2, 2023
@github-actions github-actions bot added Component - Core Affects the Core module Component - Examples Affects the Examples module Component - Plugins Affects one or more Plugins Seeding Track Finding labels Nov 2, 2023
@acts-policybot acts-policybot bot dismissed AJPfleger’s stale review November 2, 2023 15:50

Invalidated by push of be4c79a

Copy link

codecov bot commented Nov 2, 2023

Codecov Report

Merging #2616 (413c197) into main (6e56a98) will increase coverage by 0.00%.
The diff coverage is 85.71%.

@@           Coverage Diff           @@
##             main    #2616   +/-   ##
=======================================
  Coverage   49.51%   49.52%           
=======================================
  Files         472      472           
  Lines       26755    26756    +1     
  Branches    12338    12338           
=======================================
+ Hits        13249    13250    +1     
  Misses       4753     4753           
  Partials     8753     8753           
Files Coverage Δ
...nclude/Acts/Detector/detail/GridAxisGenerators.hpp 66.66% <ø> (ø)
...clude/Acts/MagneticField/InterpolatedBFieldMap.hpp 55.07% <ø> (ø)
.../include/Acts/Navigation/DetectorVolumeFinders.hpp 66.66% <ø> (ø)
...include/Acts/Navigation/DetectorVolumeUpdators.hpp 71.42% <ø> (ø)
Core/include/Acts/Surfaces/SurfaceArray.hpp 52.54% <ø> (ø)
Core/src/Detector/LayerStructureBuilder.cpp 32.45% <ø> (ø)
.../src/Detector/detail/CylindricalDetectorHelper.cpp 32.96% <ø> (ø)
Core/src/Geometry/SurfaceArrayCreator.cpp 36.22% <ø> (ø)
Core/src/MagneticField/BFieldMapUtils.cpp 51.03% <ø> (ø)
Core/src/Material/MaterialMapUtils.cpp 56.66% <100.00%> (ø)
... and 2 more

📣 Codecov offers a browser extension for seamless coverage viewing on GitHub. Try it in Chrome or Firefox today!

@kodiakhq kodiakhq bot merged commit 76cf010 into acts-project:main Nov 3, 2023
53 checks passed
@github-actions github-actions bot removed the automerge label Nov 3, 2023
kodiakhq bot pushed a commit that referenced this pull request Nov 7, 2023
This PR rationalizes the documentation a bit. The main points are

- Remove the documentation of the old standalone examples executables
- Restructure the core documentation to be less sprawling
- Move the figures from a central folder closer to the relevant source files
- Remove the full auto API documentation in favor of a combination of hard-coded documented symbols + an auto detection mechanism to catch when we references symbols somewhere
  - This reduces the time it takes to build the docs drastically
- Enable nitpicky generation, which will warn (and fail) if symbols are references that don't have a target.

- [x] Try to auto-generate API listings only for the elements we explicitly call out by class / func roles.

Blocked by:
- #2616 
- #2617 
- #2624
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Core Affects the Core module Component - Examples Affects the Examples module Component - Plugins Affects one or more Plugins Seeding Track Finding
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants